Vcenter NamespaceManagement Supervisors ControlPlane

Vcenter NamespaceManagement Supervisors ControlPlane
Vcenter NamespaceManagement Supervisors ControlPlane

Vcenter NamespaceManagement Supervisors ControlPlane schema describes the control plane configuration. It allows you to adjust configuration such as size, network, and storage required to support the control plane runtime.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "network": {
        "network": "string",
        "backing": {
            "backing": "string",
            "network": "string",
            "network_segment": {
                "networks": [
                    "string"
                ]
            }
        },
        "services": {
            "dns": {
                "servers": [
                    "string"
                ],
                "search_domains": [
                    "string"
                ]
            },
            "ntp": {
                "servers": [
                    "string"
                ]
            }
        },
        "ip_management": {
            "dhcp_enabled": false,
            "gateway_address": "string",
            "ip_assignments": [
                {
                    "assignee": "string",
                    "ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ]
                }
            ]
        },
        "floating_ip_address": "string",
        "proxy": {
            "proxy_settings_source": "string",
            "https_proxy_config": "string",
            "http_proxy_config": "string",
            "no_proxy_config": [
                "string"
            ],
            "tls_root_ca_bundle": "string"
        }
    },
    "login_banner": "string",
    "size": "string",
    "storage_policy": "string",
    "count": 0
}
network
Required

The management Vcenter NamespaceManagement Supervisors ControlPlane.network is used by vCenter and the control plane to manage the cluster. vCenter and the NSX (if used) management plane must be accessible from this network.

The Supervisor requires that management network traffic is not L3 routable from workload network traffic.

This property was added in vSphere API 8.0.0.1.

string
login_banner
Optional

Vcenter NamespaceManagement Supervisors ControlPlane.login_banner is a disclaimer displayed prior to login via the Kubectl plugin.

This property was added in vSphere API 8.0.0.1.

If this banner is missing or null, no message will be displayed to users.

string
size
Optional

Vcenter NamespaceManagement Supervisors ControlPlane.size controls the size and resources allocated to the Kubernetes API server and the worker nodes.

For more information see: Vcenter NamespaceManagement Supervisors SizingHint.

This property was added in vSphere API 8.0.0.1.

Defaults to SMALL.

string
storage_policy
Optional

Vcenter NamespaceManagement Supervisors ControlPlane.storage_policy identifies the storage policy backing the Supervisor Kubernetes API server.

This property was added in vSphere API 8.0.0.1.

This resource is required.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: SpsStorageProfile.

integer As int64 As int64
count
Optional

Number of control plane VMs requested during Supervisor enablement. The allowed values are either 1 or 3.

This property was added in vSphere API 9.0.0.0.

If missing or null, defaults to 3.